\section{fsm\+\_\+soe.\+h File Reference}
\label{fsm__soe_8h}\index{fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}}


Ether\+C\+AT CoE state machines.  


\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \textbf{ ec\+\_\+fsm\+\_\+soe}
\begin{DoxyCompactList}\small\item\em Finite state machines for the Sercos over Ether\+C\+AT protocol. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
typedef struct \textbf{ ec\+\_\+fsm\+\_\+soe} \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\label{fsm__soe_8h_a451a615dc0269059f3ed94f37f7c08c5}} 
void \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+init} (\textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$)
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item 
\mbox{\label{fsm__soe_8h_a8613b87fb1105d8a002b13bba3d86dc8}} 
void \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+clear} (\textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$)
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
\mbox{\label{fsm__soe_8h_a8eff1b86bc42789a8747d8817914d8be}} 
void \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+transfer} (\textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$, \textbf{ ec\+\_\+slave\+\_\+t} $\ast$, \textbf{ ec\+\_\+soe\+\_\+request\+\_\+t} $\ast$)
\begin{DoxyCompactList}\small\item\em Starts to transfer an I\+DN to/from a slave. \end{DoxyCompactList}\item 
int \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+exec} (\textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$, \textbf{ ec\+\_\+datagram\+\_\+t} $\ast$)
\begin{DoxyCompactList}\small\item\em Executes the current state of the state machine. \end{DoxyCompactList}\item 
int \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+success} (const \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns, if the state machine terminated with success. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Ether\+C\+AT CoE state machines. 



\subsection{Typedef Documentation}
\mbox{\label{fsm__soe_8h_a6f2210c6eb570d207312a8ea94a15527}} 
\index{fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}!ec\+\_\+fsm\+\_\+soe\+\_\+t@{ec\+\_\+fsm\+\_\+soe\+\_\+t}}
\index{ec\+\_\+fsm\+\_\+soe\+\_\+t@{ec\+\_\+fsm\+\_\+soe\+\_\+t}!fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}}
\subsubsection{ec\+\_\+fsm\+\_\+soe\+\_\+t}
{\footnotesize\ttfamily typedef struct \textbf{ ec\+\_\+fsm\+\_\+soe} \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t}}

\begin{DoxySeeAlso}{See also}
\doxyref{ec\+\_\+fsm\+\_\+soe}{p.}{structec__fsm__soe} 
\end{DoxySeeAlso}


Definition at line 47 of file fsm\+\_\+soe.\+h.



\subsection{Function Documentation}
\mbox{\label{fsm__soe_8h_aa25b538167720cd04716ce6eb81d0bcc}} 
\index{fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}!ec\+\_\+fsm\+\_\+soe\+\_\+exec@{ec\+\_\+fsm\+\_\+soe\+\_\+exec}}
\index{ec\+\_\+fsm\+\_\+soe\+\_\+exec@{ec\+\_\+fsm\+\_\+soe\+\_\+exec}!fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}}
\subsubsection{ec\+\_\+fsm\+\_\+soe\+\_\+exec()}
{\footnotesize\ttfamily int ec\+\_\+fsm\+\_\+soe\+\_\+exec (\begin{DoxyParamCaption}\item[{\textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$}]{fsm,  }\item[{\textbf{ ec\+\_\+datagram\+\_\+t} $\ast$}]{datagram }\end{DoxyParamCaption})}



Executes the current state of the state machine. 

\begin{DoxyReturn}{Returns}
1 if the datagram was used, else 0. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em fsm} & finite state machine \\
\hline
{\em datagram} & Datagram to use. \\
\hline
\end{DoxyParams}


Definition at line 152 of file fsm\+\_\+soe.\+c.

\mbox{\label{fsm__soe_8h_a3115df704100f859631f6c4476b3c997}} 
\index{fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}!ec\+\_\+fsm\+\_\+soe\+\_\+success@{ec\+\_\+fsm\+\_\+soe\+\_\+success}}
\index{ec\+\_\+fsm\+\_\+soe\+\_\+success@{ec\+\_\+fsm\+\_\+soe\+\_\+success}!fsm\+\_\+soe.\+h@{fsm\+\_\+soe.\+h}}
\subsubsection{ec\+\_\+fsm\+\_\+soe\+\_\+success()}
{\footnotesize\ttfamily int ec\+\_\+fsm\+\_\+soe\+\_\+success (\begin{DoxyParamCaption}\item[{const \textbf{ ec\+\_\+fsm\+\_\+soe\+\_\+t} $\ast$}]{fsm }\end{DoxyParamCaption})}



Returns, if the state machine terminated with success. 

\begin{DoxyReturn}{Returns}
non-\/zero if successful. 
\end{DoxyReturn}

\begin{DoxyParams}{Parameters}
{\em fsm} & Finite state machine \\
\hline
\end{DoxyParams}


Definition at line 187 of file fsm\+\_\+soe.\+c.

